GetInitialCase {Modal Ritz}

GetInitialCase

Syntax

SapObject.SapModel.LoadCases.ModalRitz.GetInitialCase

VB6 Procedure

Function GetInitialCase(ByVal Name As String, ByRef InitialCase As String) As Long

Parameters

Name

The name of an existing modal ritz load case.

InitialCase

This is blank, None or the name of an existing analysis case. This item specifies if the load case starts from zero initial conditions, that is, an unstressed state, or if it starts using the stiffness that occurs at the end of a nonlinear static or nonlinear direct integration time history load case.

If the specified initial case is a nonlinear static or nonlinear direct integration time history load case, the stiffness at the end of that case is used. If the initial case is anything else, zero initial conditions are assumed.

Remarks

This function retrieves the initial condition assumed for the specified load case.

The function returns zero if the initial condition is successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetCaseModalRitzInitialCondition()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim InitialCase As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add modal ritz load case

ret = SapModel.LoadCases.ModalRitz.SetCase("LCASE1")

'get initial condition

ret = SapModel.LoadCases.ModalRitz.GetInitialCase("LCASE1", InitialCase)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.02.

Changed nomenclature from Load Cases, Analysis Cases and Response Combinations to Load Patterns, Load Cases and Load Combinations, respectively, in version 12.00.

See Also

SetInitialCase